Skip to main content

Delete person document_by_ID

DELETE /api/v1/PersonDocuments/:id/delete

Description​

This endpoint is used to delete a person document by its unique ID.

Tags:
PersonDocuments

URL:
/api/v{version}/PersonDocuments/{id}/delete

ApiKey:
No API key required

Content-Type:
application/json

Query Parameters:
None

Path Parameters:

  • version (string, required): The API version.

  • id (string, required): The ID of the document to be deleted.

Request Body:
None

Response:
Success, returns the GUID of the deleted document.

Error Codes:
None

Example:

/api/v1/PersonDocuments/:id/delete

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Accepttext/plain

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<uuid>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request DELETE \ 
 --url  /api/v1/PersonDocuments/:id/delete \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!